Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(docs): add generated openapi docs #7975

Merged
merged 17 commits into from
Oct 10, 2023
Merged

Conversation

lahabana
Copy link
Contributor

@lahabana lahabana commented Oct 6, 2023

Checklist prior to review

  • Link to relevant issue as well as docs and UI issues --
  • This will not break child repos: it doesn't hardcode values (.e.g "kumahq" as a image registry) and it will work on Windows, system specific functions like syscall.Mkfifo have equivalent implementation on the other OS --
  • Tests (Unit test, E2E tests, manual test on universal and k8s) --
  • Do you need to update UPGRADE.md? --
  • Does it need to be backported according to the backporting policy? (this GH action will add "backport" label based on these file globs, if you want to prevent it from adding the "backport" label use no-backport-autolabel label) --
  • Do you need to explicitly set a > Changelog: entry here or add a ci/ label to run fewer/more tests?

@lahabana lahabana requested a review from a team as a code owner October 6, 2023 10:35
@lahabana lahabana requested review from Automaat and bartsmykla and removed request for a team October 6, 2023 10:35
@lahabana lahabana changed the title Better open api feat(docs): add generated openapi docs Oct 6, 2023
@lahabana
Copy link
Contributor Author

lahabana commented Oct 6, 2023

!!!! This needs an actual release of the image once: kumahq/ci-tools#31 is merged
I've also provided the connection point to enable entreprise to use it too

@lahabana lahabana added the ci/skip-test PR: Don't run unit and e2e tests (maybe this is just a doc change) label Oct 6, 2023
@lahabana lahabana force-pushed the betterOpenAPI branch 3 times, most recently from b59e2bf to e74187a Compare October 9, 2023 13:47
@lahabana lahabana added ci/skip-e2e-test PR: Don't run e2e tests and removed ci/skip-test PR: Don't run unit and e2e tests (maybe this is just a doc change) labels Oct 9, 2023
@lahabana lahabana removed the ci/skip-e2e-test PR: Don't run e2e tests label Oct 9, 2023
Copy link
Contributor

@bartsmykla bartsmykla left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One nit but LGTM overall.

mk/docs.mk Outdated Show resolved Hide resolved
Use all openapis in the repo to generate a complete
1 file version in `docs/generated/openapi.yaml`

Part of kumahq#318

Signed-off-by: Charly Molter <[email protected]>
Signed-off-by: Charly Molter <[email protected]>
Signed-off-by: Charly Molter <[email protected]>
Signed-off-by: Charly Molter <[email protected]>
Signed-off-by: Charly Molter <[email protected]>
Signed-off-by: Charly Molter <[email protected]>
Signed-off-by: Charly Molter <[email protected]>
Signed-off-by: Charly Molter <[email protected]>
Signed-off-by: Charly Molter <[email protected]>
Signed-off-by: Charly Molter <[email protected]>
Signed-off-by: Charly Molter <[email protected]>
Signed-off-by: Charly Molter <[email protected]>
Signed-off-by: Charly Molter <[email protected]>
Signed-off-by: Charly Molter <[email protected]>
Signed-off-by: Charly Molter <[email protected]>
@lahabana lahabana enabled auto-merge (squash) October 10, 2023 10:32
@lahabana lahabana merged commit 65a5e0c into kumahq:master Oct 10, 2023
5 checks passed
lahabana added a commit that referenced this pull request Oct 11, 2023
lahabana added a commit that referenced this pull request Oct 11, 2023
This reverts commit 65a5e0c.

Signed-off-by: Charly Molter <[email protected]>
@lahabana lahabana deleted the betterOpenAPI branch March 29, 2024 12:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants